Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Move more sections under hardware integration #2704

Merged
merged 6 commits into from
Jan 14, 2025

Conversation

caksoylar
Copy link
Contributor

@caksoylar caksoylar commented Dec 11, 2024

Move portions of pages that describe hardware integration parts from feature pages into dedicated pages under Hardware Integration section.

  • Defining battery sensing for battery levels
  • Underglow and backlight (discussed in docs(feat): further generalize RGB information #2485 (review))
    • I decided to have a Lighting category index page and two subpages. The index page again emphasizes when to use each system
    • Although I added links to pin control page in both pages, this is (for now) a superficial integration and further refactoring to reduce duplication should be done in another PR

PR check-list

@caksoylar caksoylar added the documentation Improvements or additions to documentation label Dec 11, 2024
@caksoylar caksoylar requested a review from a team as a code owner December 11, 2024 05:02
@caksoylar caksoylar force-pushed the docs/more-hw-integration branch 2 times, most recently from 63d2671 to b8f67d2 Compare December 11, 2024 06:49
@Nick-Munnich
Copy link
Contributor

I agree that the additional refactoring could be done in a future PR. I think that the config and feature pages ought to also be combined into one. Battery bit LGTM.

@caksoylar
Copy link
Contributor Author

I think that the config and feature pages ought to also be combined into one.

How do you envision this? I thought it's nice to have all the features' config as reference under configuration. If we move them to e.g. the feature page then the config reference section will be incomplete.

@Nick-Munnich
Copy link
Contributor

I think that the config and feature pages ought to also be combined into one.

How do you envision this? I thought it's nice to have all the features' config as reference under configuration. If we move them to e.g. the feature page then the config reference section will be incomplete.

I was unclear I think: feature pages combined into one and config pages combined into one, making two from four.

@caksoylar
Copy link
Contributor Author

Got it, yeah that makes sense. Will break quite a few links, and I should remember to add redirects.

@caksoylar
Copy link
Contributor Author

I (finally) consolidated the underglow+backlight feature and config pages as well. I added redirects for the old pages, though I don't think they work on local builds or in deploy previews.

While debugging any missing links, I also noticed the missing anchors on the dongle page, opened #2764.

Another extra is I removed an incorrect redirect from docs/features/encoders to the keymap section, since IIRC we didn't end up moving that page. I included that in this PR since I am already touching redirects and I couldn't cleanly cherry-pick it.

Copy link
Contributor

@Nick-Munnich Nick-Munnich left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM overall, just one little note.

docs/docs/intro.md Outdated Show resolved Hide resolved
@caksoylar caksoylar force-pushed the docs/more-hw-integration branch from e21ab9d to f36707a Compare January 14, 2025 05:03
@caksoylar caksoylar merged commit 700e9b2 into zmkfirmware:main Jan 14, 2025
7 checks passed
@caksoylar caksoylar deleted the docs/more-hw-integration branch January 14, 2025 05:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants